Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

PHPDoc parser: Removed p tags and added whitespace instead. #41633

Merged
merged 1 commit into from
Feb 7, 2025
Merged

PHPDoc parser: Removed p tags and added whitespace instead. #41633

merged 1 commit into from
Feb 7, 2025

Conversation

zinigor
Copy link
Member

@zinigor zinigor commented Feb 7, 2025

Fixes a problem where certain hooks would get words in the description squashed together because of missing spaces. The strip_all_tags function that outputs them would remove the </p><p> group. This change adds a whitespace instead and removes p tags entirely because they get stripped anyway.

Proposed changes:

  • Replaces p tags with whitespaces.

Other information:

  • Have you written new tests for your changes, if applicable?
  • Have you checked the E2E test CI results, and verified that your changes do not break them?
  • Have you tested your changes on WordPress.com, if applicable (if so, you'll see a generated comment below with a script to run)?

Jetpack product discussion

Does this pull request change what data or activity we track or use?

Testing instructions:

  • Go to '..'

@zinigor zinigor added [Type] Bug When a feature is broken and / or not performing as intended [Status] Needs Review To request a review from fellow Jetpack developers. Label will be renamed soon. labels Feb 7, 2025
@zinigor zinigor requested a review from tbradsha February 7, 2025 13:25
@zinigor zinigor self-assigned this Feb 7, 2025
@github-actions github-actions bot added the [Tools] Development CLI The tools/cli to assist during JP development. label Feb 7, 2025
@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Feb 7, 2025

Thank you for your PR!

When contributing to Jetpack, we have a few suggestions that can help us test and review your patch:

  • ✅ Include a description of your PR changes.
  • ✅ Add a "[Status]" label (In Progress, Needs Team Review, ...).
  • ✅ Add a "[Type]" label (Bug, Enhancement, Janitorial, Task).
  • ✅ Add testing instructions.
  • ✅ Specify whether this PR includes any changes to data or privacy.
  • ✅ Add changelog entries to affected projects

This comment will be updated as you work on your PR and make changes. If you think that some of those checks are not needed for your PR, please explain why you think so. Thanks for cooperation 🤖

The e2e test report can be found here. Please note that it can take a few minutes after the e2e tests checks are complete for the report to be available.

Follow this PR Review Process:

  1. Ensure all required checks appearing at the bottom of this PR are passing.
  2. Choose a review path based on your changes:
    • A. Team Review: add the "[Status] Needs Team Review" label
      • For most changes, including minor cross-team impacts.
      • Example: Updating a team-specific component or a small change to a shared library.
    • B. Crew Review: add the "[Status] Needs Review" label
      • For significant changes to core functionality.
      • Example: Major updates to a shared library or complex features.
    • C. Both: Start with Team, then request Crew
      • For complex changes or when you need extra confidence.
      • Example: Refactor affecting multiple systems.
  3. Get at least one approval before merging.

Still unsure? Reach out in #jetpack-developers for guidance!

tbradsha
tbradsha approved these changes Feb 7, 2025
View reviewed changes
Copy link
Contributor

@tbradsha tbradsha left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If you wanted to be really picky, you could also trim() the description, but not important.

@zinigor zinigor merged commit e33f0ec into trunk Feb 7, 2025
61 checks passed
@zinigor zinigor deleted the fix/phpdoc-parser-line-whitespace branch February 7, 2025 13:38
@github-actions github-actions bot removed the [Status] Needs Review To request a review from fellow Jetpack developers. Label will be renamed soon. label Feb 7, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@tbradsha tbradsha tbradsha approved these changes

Assignees

@zinigor zinigor

Labels
[Tools] Development CLI The tools/cli to assist during JP development. [Type] Bug When a feature is broken and / or not performing as intended
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@zinigor @tbradsha